home *** CD-ROM | disk | FTP | other *** search
/ Cobra Utilities for Doom & Doom II / Cobra Utilities For Doom & Doom II - Disc 2.iso / files / program / ulted10b / ulted.txt < prev   
Encoding:
Text File  |  1994-07-20  |  14.3 KB  |  303 lines
  1. User Manual for ULTED v1.00b
  2.  
  3. i) Particulars:
  4. ------------
  5.  
  6. Author: Peter Ott
  7. E-mail: pott@cate.ryerson.ca
  8.  
  9. **************************************************************************
  10. ULTED v1.00b is the beta release and so MUST BE USED WITH SOME CAUTION;
  11. use a backup copy of the main doom.wad file, save your level often and use
  12. several different names when saving.
  13.  
  14. As the author, I would like to express my thanks to Raphael Quinet and
  15. Brendon Wyber, the authors of DEU5.X for distributing their code.  Much
  16. of this editor, including the nodes builder and the PWAD read/write routines,
  17. came directly from DEU. 
  18. I'd also like to impress on you that there is ABSOLUTELY NO guarantee or
  19. warrantee of any kind that comes with this program.  
  20. Any comments are always welcome and can be e-mail directly to the address
  21. above... 
  22. **************************************************************************
  23.  
  24. Now to the good stuff....
  25.  
  26. 0) Contents:
  27. -----------
  28.  
  29. 1) Introduction
  30. 2) A Quick Trip through the Menus
  31. 3) What you can do Where
  32. 4) Automatic Sidedef Definition and Misc
  33. 5) Known bugs
  34. 6) Closing Remarks
  35.  
  36. *************************************************************************
  37.  
  38. 1) Introduction:
  39. -------------
  40.  
  41. If you're like me, you'd like to be able to edit your level, save it,
  42. switch to a full-screen DOS window, and play the level.  If you find any
  43. problems or things you don't like, you'd like to switch back to the editor
  44. and fix the problems as you find them...well...ULTED allows you to do that.
  45. That, and the fact that OS/2.1 is a stable platform that doesn't crash with
  46. every little access violation that comes along, was the main reason I decided
  47. to develope under the OS/2.1 environment.  This is my first OS/2 project.
  48. I didn't know the first thing about the OS before I started just under
  49. 4 months ago...but after much hair pulling (darn memory management under
  50. OS/2...heap?? what heap??? I thought malloc would work ok!!) and late nights
  51. I've finally got something stable to show for my work and I'm happy that
  52. somebody's willing to give it a try.   
  53.  
  54. Anyways, assuming that the binary arrived to you in half decent shape, 
  55. it should be executable from any directory.  It's probably best to put
  56. it right in your doom directory to reduce the amount of file dialog box 
  57. crap you have to go through to load/save a PWAD.  
  58.  
  59. ULTED can be started by double clicking on the icon (nice picture...I'm not
  60. much of an artist, but anyways...), or you can run it from the command-line
  61. of an OS/2 shell (giving it the optional location of the doom.wad file) as 
  62. in:
  63.  
  64. [c:] ulted e:\doom\doom.wad
  65.  
  66. This will start ULTED, load the doom.wad, and display E1M1.  If you don't
  67. supply the location of the wad (or it can't find it), just go to the FILE
  68. menu and choose "open main wad".  This will display a file dialog and you
  69. can find and load the main wad from there.
  70. The main wad file MUST BE LOADED FIRST before any editing can be done.  This
  71. is because the texture names etc are loaded with the main.wad file.
  72.  
  73. If all of that happened successfully, you have 3 ULTED windows open.  The 
  74. main window has the floor plans of E1M1.  This is where all the drawing,
  75. moving, deleting, etc. will happen.  Another window, the THING window,
  76. should be hanging around somewhere too.  This has everything you'll need
  77. to fool around with things (more later).  A final window, the information
  78. window, should be in the bottom left-hand corner.  This gives information
  79. about everything that ULTED has done and is useful for ensuring that what
  80. you thought SHOULD happen DID happen; for example, ULTED is
  81. capable of melting 2 vertexes together.  If you want to be sure that 
  82. 2 vertexes were melted, this will tell you.  It also spews lots of junk 
  83. when it's building the nodes when you save, letting you know it's actually
  84. working.
  85.  
  86. A quick word on the mouse.  ULTED was built to use a three button mouse.
  87. Depending on how you've got it set up with OS/2, the left button is for 
  88. selecting objects, the middle button is for getting information on an object,
  89. and the right button is for inserting a new object.  I haven't tested this, 
  90. but I THINK that a two button mouse will emulate a 3rd button if both buttons
  91. are pressed simultaneously.
  92.  
  93. 2) A Quick Trip Thru the Menus:
  94. ----------------------------
  95.  
  96. I don't think there's a real call to go through each menu item separately
  97. since they should be pretty self explanatory except to say that several
  98. of them are not implemented yet...that sucks, but the important ones work.
  99.  
  100. The FILE menu does what you'd think:
  101.  
  102.     Start New PWAD:    clears the work area and initializes the editor.  
  103.             Note that your PWAD will be injected into the 
  104.             position that you were viewing when you initiated
  105.             this option. (ie. if you were viewing E1M1 and 
  106.             initiated this option, the level you design would 
  107.             load into the E1M1 position of the main wad when you 
  108.             include it).
  109.      
  110.     Open PWAD: loads a PWAD from disk and displays it, ready for editing.
  111.  
  112.     Save (Build): saves the currently displayed PWAD, rebuilding the
  113.                nodes if it is required.
  114.  
  115.     Exit: hmmmmm....I wonder.  Note it doesn't ask you if you're sure!!
  116.  
  117. The EDIT menu:
  118.  
  119.     Clear Selections: Anything that has been selected in the edit window
  120.               becomes unselected.
  121.  
  122.     Delete Selections: Anything that has been selected is deleted.
  123.                If a vertex is deleted, any linedefs (and 
  124.                consequently Sidedefs) that are connected to the
  125.                Vertex get deleted as well.
  126.                Note the Known bugs section at the end of this
  127.                document.
  128.  
  129.     Choose Level: This allows you to go to another level (eg. E3M8) and
  130.               view the floor map.  I include this option only for
  131.               setting the level you wish to start a new PWAD at 
  132.               (see Start New PWAD above).
  133.               Note the known bugs section at the end of this 
  134.               document.
  135.  
  136. The TOOLS menu:
  137.  
  138.     Grid: Setting the snap-to-grid distance.  Off is included because
  139.           the grid is really distracting when doing fine work...
  140.  
  141.     Scaling: Zooming in and out of your map.  There is an annoying 
  142.          feature (yeah...I'll call it a feature cause it ain't a
  143.          bug) that, when you zoom out, the map moves down about 1
  144.          screen (ie. push on the down section of the scroll bar 
  145.          a couple of times to scroll it back into view).  This 
  146.          isn't a problem if you zoom out 1 level, but going from
  147.          a scale of 1 to 8 will definitely do it.
  148.  
  149.      Viewer: This is not quite working yet...but a feature that I deem
  150.          as a necessity.  The OS/2 palette is being a real pain in
  151.          the ass...this feature should be coming soon.
  152.  
  153. The MODE menu:
  154.  
  155.     This is pretty self-explanatory.  Each mode (except Vertex) brings 
  156. up it's own special dialog box (described more below).  
  157.  
  158. The HELP menu:
  159.  
  160.     No help yet, but check out the ABOUT choice...
  161.  
  162. 3) What you can do Where
  163. ------------------------
  164.  
  165. A general note: A 'set to default' button is displayed in all mode related 
  166. dialog boxes.  By choosing any desired settings appropriate to that 
  167. mode and pushing the 'set to default' button, ULTED remembers them and when
  168. a new object is inserted, it's initial settings (wall textures for example) are
  169. set to your defaults.
  170.  
  171. As well, if any object is selected and a dialog box setting is changed, the
  172. change will effect the selected object(s).  For instance: if you are in THINGS
  173. mode and select a chaingun, an imp, and Player 2, and then push on one of the
  174. direction buttons, each of these items will change to face the new direction.
  175. This is especially useful for changing the textures on many sidedefs at the
  176. same time and has proven to be one of those invaluable tools you use all the 
  177. time.
  178.  
  179. Vertex Mode:  In this mode you can move, select, insert, and delete vertexes.
  180. Selecting multiple vertexes is supported.  This can be handy if you want to 
  181. move a sector (or part of a sector) -> simply click on each of the vertexes
  182. you want to move to highlight them (they'll turn pink).  Then drag one of
  183. them and they'll all move relative to the one you're dragging.  Linedefs will
  184. automatically be made 'elastic' and stretch when you release the mouse button.
  185. Linedefs may be split by inserting a vertex at the place where you want the
  186. split to occur.  This is necessary for making shapes from the standard
  187. square sector (discussed below).
  188. To insert a line between 2 vertexes, simply highlight the vertexes that you
  189. want the linedef to go between, and click the right mouse button.  Multiple
  190. lines may be inserted by highlighting the vertexes in order (ie. the first 
  191. linedef starts at the first vertex and connects to the second, the second 
  192. linedef starts at the second vertex and goes to the third, etc).  
  193.  
  194. After a rebuild, you may see stray vertexes hanging around your map.  This 
  195. happens because the nodes builder inserts vertexes when it performs it's 
  196. linedef splitting.  These won't effect your map AT ALL, but if they bug you,
  197. just reload your PWAD after a save.
  198.  
  199. LineDef Mode:  There are 2 dialogs associated with the Linedef mode -> the
  200. main Linedef dialog that describes everything that is pertinent to the 
  201. linedef itself (no esthetics, just functionality).  Pushing on the Sidedef 
  202. info button in this dialog brings up the sidedef dialog, which shows which
  203. sector each sidedef is currently attached to and what the textures are for
  204. the upper, normal, and lower positions.  As with any of the other editors,
  205. the sector tag in the Linedef dialog defines a platform number (INDEPENDENT of
  206. sector number) that should be associated with any special action that the
  207. linedef is to perform (raise floor etc).  The Flags list box defines the flags
  208. (appropriately enough) associated with the linedef.  Any number of these flags
  209. may be selected at 1 time.  The Type list box defines the special 
  210. functionality, if any, that the linedef exhibits (only 1 of these may be
  211. selected at any time).  The Flip linedef button does just that.  Linedefs that
  212. are non-normal (perform some special function) are activated when the player
  213. walks, shoots, or switches the FIRST sidedef.  It may happen that your 
  214. linedef's first sidedef (the side facing right if the arrow is pointing up) 
  215. is facing the wrong way; a linedef flip will fix this up. 
  216. To get information about a linedef, click the middle button while on top of 
  217. the linedef.  The linedef and sidedef dialogs will change to reflect the
  218. information associated with the linedef.  If you wish to change something 
  219. (such as from 2 sided to impassible), simply select the linedef (button 1)
  220. and select the 2 sided entry in the Flags list to un-highlight 2-sided, and
  221. then select the Impassible entry to highlight it.  Any of the textures, types,
  222. sector numbers, sector tags, or flags may be changed in this way.  If you
  223. want to change more than 1 linedef at a time, just highlight more that 1 
  224. linedef.
  225.  
  226. Sector Mode: Much of the discussion on Linedefs applies to Sectors. If the
  227. mouse 'info' button is clicked inside of a sector, it's properties are 
  228. displayed in the sector dialog.  All the information in the Sector Edit dialog
  229. is editable except the sector #; this only makes sense since to changing the
  230. sector number means deleting this sector and inserting another one... not
  231. usually done.  The Platform tag entry field is the sector's equal to the Sector
  232. tag field of a Linedef.  The Platform tag number is totally independent of 
  233. any linedef number, and is only meant to match a Sector tag number (more info
  234. on that is available from any of the docs on DEU or DoomEd).  
  235. A word of warning -> If you select more than 1 sector at a time, ALL of the
  236. sector info that pertains to the most recently selected sector is transferred 
  237. to the others.  Example: say that you selected sector 6 and then selected
  238. sector 3 -> All sector 3 information such as platform tag, light level, floor
  239. and ceiling heights, etc. is copied to sector 6.  I treated this as a bug at
  240. first (the original plan was to be able to select several sectors and change
  241. a single setting on all of them), but it comes in handy for copying sectors 
  242. and I've used it quite a bit.
  243.  
  244. Thing Mode:  The Thing dialog box is slightly different than the others in 
  245. that, when the mouse 'info' button is clicked, the thing's information appears
  246. in ULTED's Information window.  This is just because I haven't got around to
  247. making the dialog box update with the mouse 'info' button yet.  All required
  248. information is still displayed.  The dialog is pretty much self explanatory,
  249. so I'm not going to go into it anymore than this.
  250. As with vertexes, multiple things may be moved or changed to be whatever you
  251. want simply by selecting them and changing the appropriate option in the 
  252. Thing Edit dialog.  One of the many things that came from the DEU5.X code is
  253. the ability to tell the size of the object by the size of the circle around it.
  254.  
  255.  
  256. 4) Automatic Sidedef Definition and Misc
  257. ------------------------------------------
  258.  
  259. If a sector is inserted into the middle of another sector, the 2nd sidedefs
  260. of this new sector are automatically set to be connected to the original
  261. outside sector.  As well, if the floor and ceiling heights of the default
  262. sector were defined before it was inserted, ULTED will automagically decide
  263. whether upper, normal, or lower sidedefs are required and set them to the
  264. default textures.  This can and will save A LOT of TIME.  It's worth trying
  265. to figure it out.   
  266.  
  267. As well, when 2 lines are melted (by melting the 2 vertexes from 2 separate
  268. linedefs together) the linedef flag is automagically set to 2-sided and the
  269. impassible flag is negated (this serves as a significant time saver as well). 
  270.  
  271. 5) Known bugs: 
  272. ------------
  273.  
  274. 1. Don't try to delete more than 1 sector at a time because ULTED will
  275. crash.  I have an idea what the problem is, I just haven't had time to
  276. fix it.
  277.  
  278. 2. You have the ability to "Choose Level".  Doing this several times in
  279. succession may(?) cause the editor to crash.  The moral of the story is:
  280. don't look around -> go to the level you wish to edit and do it.
  281.  
  282. 3. Though the nodes builder contained in ULTED functions, it has cause the
  283. infamous HOM effect to happen in several of my test levels.  It is recommended
  284. that BSP1.X be run on the saved PWAD before running it.  This will clear
  285. up any minor node problems (by doing this, I've had NO problems with any of
  286. the levels I've built with ULTED).
  287.  
  288.  
  289. 6) Closing Remarks:
  290. -------------------
  291.  
  292. I know that I haven't covered in detail HOW to go about building a level and
  293. I might've even left some stuff out about the editor, but if anything comes up,
  294. please feel free to e-mail me about it (I'm always open to suggestions as 
  295. well, although I can't guarantee that anything'll be implemented soon....
  296.  
  297. Have fun, and keep the world of Doom alive ....
  298.  
  299. -Pete
  300.  
  301.  
  302.   
  303.